Introduction
The following Assetic REST API endpoint may be used to retrieve a list of one or more resources.
GET /api/v2/resource
-
Paginated list of resources.
-
Search filters, pagination and ordering can be applied as per the article Search-Filters-and-Pagination
Sample Payloads
The following request gets the resource with a display name of 'Roger Federer'
https://demo.assetic.net/api/v2/resource?requestParams.filters=DisplayName~eq~'Roger%20Federer'
The following request gets the resource using the first and surname of the resource
https://[your_site.assetic.net]/api/v2/resource?requestParams.filters=FirstName~eq~'Roger'~and~Surname~eq~'Federer'
Note: Depending on how the resource was created the resource may not have a firstname or surname but will always have a display name.
The following request gets a list of resources with an 'Active' status
https://[your_site].assetic.net/api/v2/resource?requestParams.filters=Status~eq~'Active'
Sample Response
The following is a sample request and response, showing resources with an Assetic email address. The results are limited to the 5th page where pagesize is set to 2.
Request
https://[your_site].assetic.net/api/v2/resource?requestParams.filters=FirstName~neq~''~and~Surname~neq~''~and~Email~contains~'assetic.com'&requestParams.page=5&requestParams.pageSize=2
Response
{ "TotalResults": 17, "TotalPages": 9, "Page": 5, "ResourceList": [ { "Id": "68b1fa99-9062-e611-9469-06edd62954d7", "DisplayName": "Indy Sehra (Assetic City Council)", "FirstName": "Indy", "Surname": "Sehra", "Company": "Assetic City Council", "Position": "Sales Manager", "Phone": "", "Mobile": "", "Fax": null, "Email": "isehra@assetic.com", "AddressComment": "Lvl 12, 257 Collins St, Melbourne VIC 3000, Australia", "ExternalID": "", "StatusId": 1, "Status": "Active", "Types": [ { "Id": 16, "Type": "Employee", "_links": [], "_embedded": null } ], "_links": [], "_embedded": null }, { "Id": "803384cb-1590-e611-946c-06edd62954d7", "DisplayName": "James Esson (Assetic)", "FirstName": "James", "Surname": "Esson", "Company": "Assetic", "Position": "", "Phone": "0400000000", "Mobile": "", "Fax": null, "Email": "jesson@assetic.com", "AddressComment": "Lvl 12, 257 Collins St, Melbourne VIC 3000, Australia", "ExternalID": "", "StatusId": 1, "Status": "Active", "Types": [], "_links": [], "_embedded": null } ], "_links": [], "_embedded": null }
